home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 007 / designer.arc / DESIGNER.DOC < prev   
Text File  |  1985-05-28  |  36KB  |  1,192 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                 THE DESIGNER
  22.                 Version 1.0
  23.  
  24.  
  25.          A BASIC Animation Programming Tool for the IBM PC
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.                    User's Manual
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.                           Copyright 1983 by Jan B. Young
  46.                                   April 29, 1983
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.                 THE DESIGNER
  70.                  V1.0 User's Manual
  71.  
  72.  
  73.  
  74.  
  75.                  Table of Contents
  76.  
  77.  
  78.     I.  Introduction
  79.         A.    Overview                   2
  80.         B.    Capabilities                   2
  81.         C.    Benefits and Advantages            3
  82.         D.    Requirements                   3
  83.  
  84.        II.  General Information
  85.         A.    Description of Functions           4
  86.         B.    Definition of Terms               5
  87.         C.    Explanation of General Concepts        5
  88.  
  89.       III.  How to Use the Program
  90.         A.    What to Do The First Time (Only)       7
  91.         B.    Using The Designer               8
  92.         C.    Using Files Created by The Designer      11
  93.         D.    "DEMO"                                    12
  94.         E.    What To Do If an Error Occurs          13
  95.  
  96.        IV.  Administration
  97.         A.    Warranty and Disclaimer           14
  98.         B.    Program Distribution              14
  99.         C.    Questions and Problems              14
  100.         D.    Maintenance and Enhancements          15
  101.  
  102.     V.  Reference Material
  103.         A.    Command Summary               16
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129. April 29, 1983                                  Page 1
  130.  
  131.  
  132.  
  133.  
  134.  
  135.                 THE DESIGNER
  136.                  V1.0 User's Manual
  137.  
  138.  
  139.  
  140.                   I. INTRODUCTION
  141.  
  142.  
  143.                 A. OVERVIEW
  144.  
  145. The Designer  is a programming    tool for  BASIC users working  with animated
  146. graphics on an    IBM-PC.   It can be  of significant value to  people writing
  147. graphic games and to people interested in experimenting with animation.
  148.  
  149. The Designer is written in IBM advanced BASIC (BASICA).   The source code is
  150. included for those who wish to study  and/or modify it.   Since The Designer
  151. uses dynamic array dimensioning, it cannot be compiled.
  152.  
  153. Included with The Designer is a  demonstration program which illustrates one
  154. way to program animation.    "Demo" is also provided in source  code form so
  155. you can study and/or modify it as you wish.
  156.  
  157. The Designer is distributed without charge.  If you are using it and find it
  158. to be of value, a contribution ($25 suggested) would be appreciated.
  159.  
  160.                Jan B. Young
  161.                767 N. Holden St.
  162.                Port Washington, Wi.  53074
  163.  
  164. Regardless of whether you make a  contribution or not,    individuals,  clubs,
  165. and  other  non-profit organizations  are  granted  permission to  copy  and
  166. distribute programs, data files, and documentation to others, providing that
  167. no charge is made  for the software.   Distribution costs may  be charged to
  168. recipients providing they do not exceed $7 per copy.
  169.  
  170. The programs,  data files,  and documentation  may be modified as desired by
  171. any  individual or  non-profit    organization,    and the  modified  materials
  172. distributed providing the following is    retained without modification:     all
  173. appearances of the copyright notice, all warranty disclaimers,    all material
  174. explaining distribution policies, and all requests for contributions.  Users
  175. distributing modified program  or documentation copies are  also required to
  176. add the words "User Modified" wherever The Designer's version number appears
  177. and must distribute  without charge (other than the  $7 maximum distribution
  178. cost).
  179.  
  180.  
  181.                   B. CAPABILITIES
  182.  
  183. The  objective of  The    Designer  is to  create  data  files of  two  types,
  184. "screens" and  "sprites".   A "screen  file" contains  the image of  a fixed
  185. background (the  scenery behind your game).    A "sprite file"  contains the
  186. image  of a  character    which  your BASIC  programs  can  move about.     The
  187. completed  screen  and    sprite    files are  input  data    for  your  animation
  188. programs.
  189.  
  190. The Designer features full use of the  PC's function keys to control program
  191. function.   It    has online-help capabilities  and is  able to print  a handy
  192. reference card on your printer.  This documentation is included on the disk.
  193.  
  194.  
  195. April 29, 1983                                  Page 2
  196.  
  197.  
  198.  
  199.  
  200.  
  201.                 THE DESIGNER
  202.                  V1.0 User's Manual
  203.  
  204.              C. BENEFITS AND ADVANTAGES
  205.  
  206. The Designer was born of the frustration  involved in an early attempt on my
  207. part to write a game.  I found that I was spending as much time creating the
  208. images as I  was programming the game  logic and decided that  a generalized
  209. tool would be of value.
  210.  
  211. With The Designer,  your  PC can be used like an  artist's canvas.   You can
  212. draw on the screen in color,  store your work in either "screen" or "sprite"
  213. form,  and recall  it later to make changes.   All  calculations required to
  214. create the files  are performed automatically and you  need concern yourself
  215. only with the artwork and the graphic appearance of your images.
  216.  
  217. The Designer, together with Demo,  can also be a learning experience for you
  218. if  you  aren't  familiar  with   animation  programming.    Since  Demo  is
  219. modifiable,   it gives    you  a starting  place and  some  ideas for  program
  220. architecture and design.
  221.  
  222. Whether your programs  are modifications of Demo or not,   they can directly
  223. read both  screen and sprite files  created by The Designer,   limiting your
  224. programming effort to the game logic and its presentation to the user.
  225.  
  226.  
  227.                   D. REQUIREMENTS
  228.  
  229. The Designer requires  an IBM-PC with at  least 64K of memory,     PC-DOS with
  230. BASICA, a color/graphics adapter, an 80-character display,  and at least one
  231. disk drive (two recommended).
  232.  
  233. The  Designer,     and  this  manual,   assume   that  you  have    a  beginning
  234. understanding of programming concepts and a beginning knowledge of BASIC.
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261. April 29, 1983                                  Page 3
  262.  
  263.  
  264.  
  265.  
  266.  
  267.                 THE DESIGNER
  268.                  V1.0 User's Manual
  269.  
  270.  
  271.  
  272.               II. GENERAL INFORMATION
  273.  
  274.  
  275.             A. DESCRIPTION OF FUNCTIONS
  276.  
  277. The Designer supports ten different functions,     each accessed by pressing a
  278. function key on the IBM PC.  All functions are available at any time, simply
  279. by pressing the appropriate function key.
  280.  
  281. The Designer's ten functions are:
  282.  
  283. Fctn Key   Function
  284. --------   ------------------------------------------------------------
  285.    1       NEW - Begin a new image on the screen.  Both high and medium
  286.          resolution are supported.    Colors are supported to the
  287.          extent that the color/graphics adapter supports them.
  288.          The cursor control keys are used to draw lines.  Special
  289.          commands draw diagonals, circles, arcs and paint-in areas
  290.          with color.
  291.    2       SCL - Scale. The Designer can expand and contract images on
  292.          the screen.  This allows you to create an original image
  293.          in a convenient size and then enlarge or reduce it for
  294.          actual use.
  295.    3       SSP - Store Sprite.    Function key 3 causes the image now on
  296.          the display to be stored as a sprite.
  297.    4       SSC - Store Screen.    Function key 4 causes the image now on
  298.          the display to be stored as a background screen.
  299.    5       RSP - Retrieve Sprite.  The Designer can, of course, read
  300.          the sprite files it creates and permits sprites to be
  301.          modified.    Modified sprites can be saved either as a new
  302.          sprite or as a screen.
  303.    6       RSC - Retrieve Screen. Similar to sprites, saved screens can
  304.          be retrieved from disk, modified and saved.  Segments of
  305.          screens can be saved as sprites, giving flexibility
  306.          in the application of your artwork.
  307.    7       TXT - Add Text.  Sometimes background screens (or even
  308.          sprites) involve text characters.    The Designer includes
  309.          a library of characters, and is able to locate them on
  310.          your artwork as you direct.
  311.    8       ANI - Test Animation.  Since the overall effectiveness of
  312.          animated graphics is dependent on the integration of
  313.          screens and sprites, The Designer includes the ability
  314.          to simultaneously retrieve a screen and a sprite, to
  315.          display both, and to permit movement of the sprite.
  316.    9       INS - Instructions.    Function key 9 returns you to the
  317.          master menu from any place in The Designer.  From the
  318.          master menu, helps covering all functions and general
  319.          system use can be requested.  In addition, the master
  320.          menu permits changes to the default disk drive and the
  321.          printing of a handy reference card.
  322.   10       Stop.  Function key 10 stops execution of The Designer.
  323.  
  324. These functions are explained in further detail in section III.C.
  325.  
  326.  
  327. April 29, 1983                                  Page 4
  328.  
  329.  
  330.  
  331.  
  332.  
  333.                 THE DESIGNER
  334.                  V1.0 User's Manual
  335.  
  336.                B. DEFINITION OF TERMS
  337.  
  338. The Designer uses the following terms which may be new to you:
  339.  
  340. Pixel - The color/graphics adapter's display is made up of a large number of
  341.    dots, called pixels.   The pixels can be colored in medium resolution and
  342.    black or white in high resolution.    Medium resolution graphics gives you
  343.    200 pixels vertically by 320 horizontally.  High resolution gives you 200
  344.    by 640.
  345.  
  346. Screen    -   "Screens"   are  commonly  used  as   backgrounds  in  animation
  347.    programming.   By definition,  a screen is  the full size of your display
  348.    (200x320 pixels  in medium  resolution and  200x640 in  high resolution).
  349.    Screens are retrieved using the BASIC BLOAD statement.
  350.  
  351. Sprite - "Sprites" are smaller figures  which can be superimposed on screens
  352.    and moved about as dictated by  game logic.     Sprites require more memory
  353.    per unit area than screens,    but  are movable in single pixel increments.
  354.    The smaller the sprite, the faster it moves and the less memory it uses.
  355.  
  356. Image  &   Figure  -   The  Designer   uses  the  terms  Image     and  Figure
  357.    interchangably  to denote  artwork on  the display.      Since artwork  can
  358.    become either  a "screen" or  a "sprite"  at your command,   The Designer
  359.    refrains from using terms which imply one orientation or the other.
  360.  
  361.  
  362.              C. EXPLANATION OF GENERAL CONCEPTS
  363.  
  364. BASICA supports two  key statements of value to the  programmer working with
  365. animation:  BLOAD and  PUT.   You should read about these  statements in the
  366. BASIC manual, as well as reviewing the short explanations given here.
  367.  
  368. BLOAD
  369.  
  370. The BASIC  BLOAD statement moves  data from a file  to a location  in memory
  371. specified  by the  programmer.     One  of the  major  uses for  BLOAD is  the
  372. transfer of an image from a file into the screen buffer.
  373.  
  374. The color/graphics  screen buffer is  16K long,   so the operation  of BLOAD
  375. takes a few seconds.   BLOAD fills  the buffer linearly.   Since the display
  376. unit scans the display    (and uses the buffer)  in an  odd-even pattern,  you
  377. will be  able to  watch BLOAD work  first in  horizontal stripes,   and then
  378. filling in between the stripes.
  379.  
  380. When programming with BLOAD,  remember that the statement assumes that files
  381. to be loaded  will be qualified with  ".BAS".   If you rename  a screen file
  382. that was created by The Designer, be sure to retain the .BAS suffix.
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393. April 29, 1983                                  Page 5
  394.  
  395.  
  396.  
  397.  
  398.  
  399.                 THE DESIGNER
  400.                  V1.0 User's Manual
  401.  
  402. PUT
  403.  
  404. PUT differs from BLOAD in several respects.   First, it moves data only into
  405. the screen buffer and only from a basic subscripted variable.  Second, it is
  406. able to load a    portion of the buffer as directed  by the programmer,  while
  407. BLOAD is really effective only for loading the entire buffer.  And third, it
  408. is able to restore the screen to  its prior appearance,  simply by executing
  409. another PUT (using the XOR mode).
  410.  
  411. PUT works under four modes: AND, OR, XOR, and PSET.   The use of these modes
  412. is  explained  in  the    BASIC  manual,      but  may  be    best  understood  by
  413. experimenting  with them.    Try  creating a  screen  and  sprite using  The
  414. Designer,  and then use The Designer's animation test facility to experiment
  415. with the different modes.
  416.  
  417. Remember that  PUT runs  much faster on  small sprites    than on  large ones.
  418. Animation of small characters,    therefore,  will be much faster and smoother
  419. than large ones.
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459. April 29, 1983                                  Page 6
  460.  
  461.  
  462.  
  463.  
  464.  
  465.                 THE DESIGNER
  466.                  V1.0 User's Manual
  467.  
  468.  
  469.  
  470.             III. HOW TO USE THE PROGRAM
  471.  
  472.  
  473.  
  474.             A. WHAT TO DO THE FIRST TIME (ONLY)
  475.  
  476. When you first receive The Designer, it will have the following files on the
  477. diskette:
  478.  
  479.       DESIGNER.BAS     The Designer program
  480.       VERBIAGE         Helps, menus, and the like.  This file is
  481.                input data.    The Designer won't run
  482.                without it.
  483.       TEXTCHAR         Text character images.  If this file is
  484.                deleted, The Designer will work, but use
  485.                of Function Key 7 will cause an abend.
  486.       DESIGNER.DOC     This document, which can be printed by
  487.                typing "COPY A:DESIGNER.DOC LPT1:"
  488.       DEMO.BAS         Animation Demo Program
  489.       MOUSE.SPR      Input to Demo (See IV.C)
  490.       MAZE.RES         Input to Demo (See IV.C)
  491.       MAZE.BAS         Input to Demo (See IV.C)
  492.  
  493. Starting The Designer the first time is done like this:
  494.  
  495. Step 1: BACKUP THE DISK.  This is IMPORTANT.   Use DOS DISKCOPY and a fresh,
  496.    blank disk for backup.  If you need help, read about DISKCOPY in your DOS
  497.    manual.
  498.  
  499. Step 2:  If you're anxious to play with your  new toy (as I always am when I
  500.    get new software)   do step 2.   If you  want to do it  "right" the first
  501.    time, then skip step 2 and proceed to step 3.
  502.  
  503.    Insert your DOS disk  in drive A and boot the  system.   Type "BASICA" to
  504.    invoke advanced  basic.   Remove  the DOS disk  and insert  The Designer.
  505.    Type "RUN DESIGNER".
  506.  
  507. Step 3.  To do it "right":
  508.  
  509.    a. If you have only one disk drive, you may want to create a "production"
  510.       version of The Designer.     To do this,  first format a blank diskette,
  511.       and  then   move    the  following    files    onto  it  using   DOS  COPY:
  512.       DESIGNER.BAS,  VERBIAGE,    TEXTCHAR.   The other files delivered on The
  513.       Designer's diskette are not required for operation of the system.
  514.  
  515.    b. Insert your DOS diskette in drive A and boot the system.
  516.  
  517.    c. Type "SYS B:".   When the prompt appears,  insert The Designer.   This
  518.       step  loads  the    hidden    files IBMBIO.COM  and  IBMDOS.COM  onto  The
  519.       Designer's diskette.
  520.  
  521.    d. Type "COPY COMMAND.COM B:".   When  the first prompt appears,  replace
  522.       The Designer  with the DOS disk.      When the second appears,   put The
  523.       Designer back.
  524.  
  525. April 29, 1983                                  Page 7
  526.  
  527.  
  528.  
  529.  
  530.  
  531.                 THE DESIGNER
  532.                  V1.0 User's Manual
  533.  
  534.    e. Repeat 2c,  typing "COPY BASICA.COM B:".   This completes installation
  535.       of the IBM software on The Designer's diskette.
  536.  
  537.    f. Now type the following commands:
  538.         COPY CON: AUTOEXEC.BAT <Enter>
  539.         BASICA DESIGNER/S:512 <Enter>
  540.         <Cntl-Break>
  541.  
  542.    Once you have completed  step 3,  The Designer can be  started by booting
  543.    your PC with The Designer's diskette in drive A.
  544.  
  545. 4. Regardless of  whether you  use step  2 or  step 3,     the first  time you
  546.    operate The    Designer,  it will  ask you which  drive should be  used for
  547.    storage.  Respond with A, B, C, or D.   This data will be stored in a new
  548.    file called    DESIGNER.DRV and you  will not    be asked the  question again
  549.    (unless  the  new  file  is    destroyed).   If  you  want  to  change  the
  550.    designation at  any time,   you can do  so.     See  section B.3  below for
  551.    details.
  552.  
  553.  
  554.                B. USING THE DESIGNER
  555.  
  556. Detailed instructions for  operating The Designer appear in  the helps which
  557. are available online during any session.  For reasons of space economy, most
  558. of this information is not duplicated  here.   Instead,  this section of the
  559. manual contains additional information and hints which may be of value.
  560.  
  561. The helps can be  printed and appended to this manual if you  wish to do so.
  562. Printing can be  done by running The  Designer,  calling the helps  from the
  563. main menu, and using PrtSc to print them.
  564.  
  565.  
  566.  1.  Overall Scheme
  567.  
  568. The Designer is intended  to be a tool for the    programmer who is interested
  569. in experimenting with animated graphics or writing games or other animations
  570. using the IBM BASICA lanugage on an IBM PC.
  571.  
  572. BASIC  provides   several  powerful  animation    statements   permitting  the
  573. programmer to  display backgrounds  and movable  elements and  to move    them
  574. around    the screen.    In  particular,    the  BLOAD  and  PUT statements  are
  575. valuable.   These statements move images onto  the screen and are capable of
  576. animation.  You should refer to the IBM BASIC manual for more information.
  577.  
  578. But,  BLOAD and PUT both require images  which have already been created and
  579. exist either in  memory or in a  disk file.   BASIC provides  no significant
  580. support for the creation of the images.
  581.  
  582. This  is The  Designer's  role -  the creation  of  backgrounds and  movable
  583. characters in a form usable by the BASIC BLOAD and PUT statements.
  584.  
  585. Assuming you are writing a game involving animated graphics, The Designer is
  586. intended to be used as follows:
  587.  
  588.  
  589.  
  590.  
  591. April 29, 1983                                  Page 8
  592.  
  593.  
  594.  
  595.  
  596.  
  597.                 THE DESIGNER
  598.                  V1.0 User's Manual
  599.  
  600.     - Design your game.    Divide the display images  into fixed backgrounds
  601.       and movable characters.    Get a rough idea of the game logic and think
  602.       about the shape, form and color of screens and sprites.
  603.  
  604.     - Use The Designer to draw and save, one by one, the screens and sprites
  605.       your game will use.
  606.  
  607.     - Use The  Designer's animation test  facilities to inspect  the screens
  608.       and sprites  in combination to  assure that  things fit and  look good
  609.       together.
  610.  
  611.     - Start the programming.   Use the BASIC  manual for help with the BLOAD
  612.       and PUT statements.    Look over the Demo program that  comes with The
  613.       Designer for  ideas and  for help  in applying  the screen  and sprite
  614.       files created by The Designer.
  615.  
  616.     - If you find that additional screens and sprites are required,  use The
  617.       Designer to make them.
  618.  
  619.     - If  you find  that changes  are needed  to screens  and sprites,     The
  620.       Designer will help you make them.
  621.  
  622.  
  623.  2.  Starting
  624.  
  625. If you have been through the steps in section III.A of this manual, starting
  626. The Designer  is a  matter only  of inserting  the diskette  in drive  A and
  627. booting your PC.   If you have not done III.A,    refer to it for instructions
  628. on starting The Designer.
  629.  
  630.  
  631.  3.  Using the Function Keys
  632.  
  633. With only a very  few exceptions,  any function key can be  used at any time
  634. throughout The    Designer.   However,   be careful when    you have  artwork in
  635. progress.  If, for instance, you use function key 9 (which calls up the main
  636. menu)  with artwork in progress,  The Designer will assume that you are done
  637. with the  artwork and  will clear the  screen to fill  your request  for the
  638. menu.
  639.  
  640.  
  641. 4.  Changing the Default Disk Drive
  642.  
  643. To change  the default diskette  drive used by    The Designer for  storage of
  644. screen and sprite files,  move to the  master menu (F9)  and type DRV.     The
  645. menu will  be refreshed and  the notation  (last line)    showing  the default
  646. drive will change.   Moving from A to  B requires one entry of DRV.   Moving
  647. from B to A  requires cycling through C and D.     All  changes to the default
  648. drive are  permanent and will  remain in effect  through future uses  of The
  649. Designer until explicity changed by you.
  650.  
  651.  
  652. 5.  Cursor Management
  653.  
  654. The use  of function  keys 2,  5  or 6 immediately  results in    changing the
  655. cursor to the current foreground color.   Therefore,  the cursor can be made
  656.  
  657. April 29, 1983                                  Page 9
  658.  
  659.  
  660.  
  661.  
  662.  
  663.                 THE DESIGNER
  664.                  V1.0 User's Manual
  665.  
  666. to  disappear  by  setting  the foreground  color  as  appropriate  to    your
  667. situation before using these function keys.   If the foreground color is not
  668. correctly set,    the cursor will become a  permanent part of the image and it
  669. will be  necessary to  retrieve the  saved image  to erase  it.   Therefore,
  670. always check foreground color before using function keys 2, 5, or 6.
  671.  
  672.  
  673. 6.  Using the Enter Key
  674.  
  675. The Designer is  largely controlled with fixed-length  commands and function
  676. keys.    To  make it easier  to use,  it is  designed to respond  to commands
  677. without waiting for you to press the enter key.  In most cases the enter key
  678. has been rendered inoperative.
  679.  
  680. The exception  to this rule  lies in the  entry of  file names which  can be
  681. anywhere from  one to eight characters    long.    Since The Designer  does not
  682. know how long a  file name will be,  it waits for you  to press enter before
  683. responding.
  684.  
  685.  
  686. 7.  File Names.
  687.  
  688. When storing or retreiving either screens or sprites,  The Designer requests
  689. a file name.  The Designer will append file qualifiers, relieving you of the
  690. need to type them.
  691.  
  692. It is  best to    refrain from using  "DESIGNER" as a  file name.    You might
  693. overwrite the program itself, permanently loosing it.    Unless Demo has been
  694. moved to  another diskette,   "DEMO",  "MOUSE",  and  "MAZE" should  also be
  695. considered reserved names.
  696.  
  697.  
  698. 8.  Upper and Lower Case
  699.  
  700. In all cases but one,  if you  type lower case characters into The Designer,
  701. they  will be  converted into  upper case  before being  displayed or  used.
  702. Therefore, you need not be concerned about cases.
  703.  
  704. The exception is function 7,  which allows inclusion of text on your images.
  705. Since both upper and lower case characters are supported,  the status of the
  706. shift, and capslock keys will be recognized and used.
  707.  
  708.  
  709. 9.  Sound
  710.  
  711. The  Designer involves    a great  deal of  full-screen work  which cannot  be
  712. disturbed by  printing messages on  the display.    Yet in some  cases,  The
  713. Designer needs to  confirm that it has    completed a requested task,   and in
  714. some cases it has to report problems.
  715.  
  716. The display-in-use problem is circumvented using the PC's speaker.  When The
  717. Designer  wants to  confirm that  it  has done    what  you asked  it to    (and
  718. particularly when its actions do not make any visible change to the screen),
  719. it will confirm with three high-pitched beeps.    When The Designer encounters
  720. an error, it reports with a low-pitched warble.
  721.  
  722.  
  723. April 29, 1983                                 Page 10
  724.  
  725.  
  726.  
  727.  
  728.  
  729.                 THE DESIGNER
  730.                  V1.0 User's Manual
  731.  
  732.            C. Using Files Created by The Designer
  733.  
  734. The Designer  is intended to be  a tool to  create data files which  will be
  735. read by your  programs.   Discussion of the  contents of these files  and of
  736. their use in your programs is, therefore, important.
  737.  
  738.  
  739. Screen Files
  740.  
  741. When you save a screen using The Designer, two files are created.   The file
  742. names  default to  SCREEN.RES and  SCREEN.BAS,    but  can be  changed by  The
  743. Designer if you tell it to do so, or can be changed using RENAME later.
  744.  
  745. The  RES file  will  consist of  a single  record  containing the  following
  746. information:
  747.  
  748.     The resolution (2= high, 1=medium)
  749.     The background color (0 through 15)
  750.     The palette (0 or 1)
  751.  
  752. The RES file is necessary because this information is not stored by BSAVE in
  753. creating  the BAS  file.   Since  BASIC does  not  provide a  simple way  of
  754. appending the screen to the RES file, two files are used.
  755.  
  756. The RES file  should be read with the following  BASIC statements (obviously
  757. you should use the correct file and  variable names for your program)  taken
  758. from DEMO.
  759.  
  760.     OPEN "A:MAZE.RES" FOR INPUT AS #1
  761.     INPUT #1,RES,BAK,PAL
  762.     CLOSE #1
  763.  
  764. Use of    the RES  file is  not required in  your program.    If you  know the
  765. correct values for the resolution,  background color,  and palette,  you can
  766. write them  into the program  and avoid using the  RES file.   You  can even
  767. erase the RES file.   If, however,  you aren't sure what the values might be
  768. in the future, data in the RES file can be checked to prevent errors.
  769.  
  770. The  BAS file  is used    directly by  BLOAD.    Its format  and contents  are
  771. controlled entirely by BASIC.  The required statements are:
  772.  
  773.     SCREEN RES
  774.     COLOR BAK,PAL
  775.     CLS
  776.     DEF SEG=&HB800
  777.     BLOAD "A.MAZE",0
  778.     DEF SEG
  779.  
  780.  
  781. Sprite Files
  782.  
  783. Saving a sprite results in the creation of a single data file bearing a name
  784. you specified (there is no default in this case) with a .SPR extension.
  785.  
  786.  
  787.  
  788.  
  789. April 29, 1983                                 Page 11
  790.  
  791.  
  792.  
  793.  
  794.  
  795.                 THE DESIGNER
  796.                  V1.0 User's Manual
  797.  
  798. The first record in a sprite file contains the following:
  799.  
  800.     The resolution (2= high, 1=medium)
  801.     The palette (0 or 1)
  802.     The size of the array required to hold the sprite
  803.     The width of the sprite (in pixels)
  804.     The height of the sprite (in pixels).
  805.  
  806. Subsequent records contain  the ASCII values of the characters    that need to
  807. be loaded into the array to represent the sprite.
  808.  
  809. The statements required to load a sprite from a file created by The Designer
  810. are:
  811.  
  812.     OPEN "A:MOUSE.SPR" FOR INPUT AS #1
  813.     INPUT #1,RES,PAL,ARR,WID,HGHT
  814.     DIM MOUSE(ARR)
  815.     FOR I=0 to ARR
  816.        INPUT #1, J(0),J(1),J(2),J(3)
  817.        P=VARPTR(MOUSE(I))
  818.        FOR N = 0 to 3
  819.           POKE P+N,J(N)
  820.        NEXT N
  821.     NEXT I
  822.     CLOSE #1
  823.  
  824. Similar to Screen files,  if you know the resolution and palette information
  825. and the array size, you can avoid a small amount of computing by writing the
  826. values directly into your program.   In this  case,  you will have to delete
  827. the first line from the sprite file using either EDLIN or some other editor.
  828.  
  829. The sprite width and height are supplied only as a convenience to you.    They
  830. need not be used at all in your program.
  831.  
  832. When your program has finished loading the  array,  and has moved the screen
  833. into the screen buffer,  the BASIC PUT statement is used to apply and remove
  834. the sprite from the screen according to your program's logic.
  835.  
  836.  
  837.                  D. "DEMO"
  838.  
  839. The program "Demo" is  intended only as a demonstration of  the abilities of
  840. The Designer  and of BASICA animation.      It is not  a game,  nor is  it the
  841. ultimate in animation technique.   In fact,   Demo is purposefully less than
  842. optimum to enhance program legibility.
  843.  
  844. Demo,  when  run,  displays a  maze and a  mouse than wanders  randomly (and
  845. slowly)  through the maze.   Compiling this program will make the mouse move
  846. much faster and will make watching it more fun,  but will eliminate the real
  847. benefit of the program, reading the code.
  848.  
  849.  
  850.  
  851.  
  852.  
  853.  
  854.  
  855. April 29, 1983                                 Page 12
  856.  
  857.  
  858.  
  859.  
  860.  
  861.                 THE DESIGNER
  862.                  V1.0 User's Manual
  863.  
  864. To run Demo,   stop The Designer with  function key 10 and  type "RUN DEMO".
  865. Demo requires no user  input - you can just sit and watch  it go.   When you
  866. are tired of it, stop it with Cntl-Break and type "LIST" to see the program.
  867. Print the  program using  "LLIST" and  study,  especially,   the use  of the
  868. MOUSE.SPR, MAZE.RES, and MAZE.BAS files in lines 10180 through 10410.
  869.  
  870.  
  871.                E. IF AN ERROR OCCURS
  872.  
  873. The Designer  should catch  all possible  user errors  and provide  complete
  874. error diagnostics  and opportunities to  correct errors online.    Since the
  875. online diagnostics are very complete, they are not documented here, with one
  876. exception.
  877.  
  878. The Designer uses dynamic array definition  to build arrays for transferring
  879. sprites from your display to diskette.    It is possible for you to attempt to
  880. store a sprite    which is so large  that the required array  would exceed the
  881. available memory.
  882.  
  883. Should you exceed the available memory, The Designer will detect the problem
  884. before crashing.   Since your sprite is still  on the screen,  and is stored
  885. nowhere except the  screen buffer,  The Designer refrains  from clearing the
  886. screen and provides  only an error tone  (a low warble -  see above).    When
  887. this happens,  you have a choice:  You can  reduce the size of the sprite by
  888. closing down the box further, or you can abort the whole thing by pressing a
  889. function key.
  890.  
  891. The Designer contains one intermittent bug that I haven't been able to track
  892. down.    Occasionally when saving a screen,  you  may get a syntax error on a
  893. non-existent line number.  When this happens The Designer will probably lock
  894. up and you  will have to re-boot  your PC.   However,  the  DIR command will
  895. reveal that all is not lost - your screen has been saved as SCREEN.BAS.   If
  896. you rename it and restart The Designer, you can continue from where you were
  897. when you were interrupted.
  898.  
  899. If you can figure out what's wrong with the program,  I would like very much
  900. to know.  Please write to me at the address below.
  901.  
  902. In addition  to these  errors and  messages,  you  may run  across an  error
  903. message in the form:
  904.  
  905.     Error Number nnn on Line Number nnn
  906.  
  907. followed by a BASIC OK.   This message    means that The Designer has crashed.
  908. I would  also like very  much to know about  crashes.    Please write  to Jan
  909. Young, 767 N.  Holden St., Port Washington, Wi.  53074,  and include as much
  910. detail as possible  about what you were  doing when the problem  arose,  and
  911. what suspicions you have, if any, about the causes.
  912.  
  913.  
  914.  
  915.  
  916.  
  917.  
  918.  
  919.  
  920.  
  921. April 29, 1983                                 Page 13
  922.  
  923.  
  924.  
  925.  
  926.  
  927.                 THE DESIGNER
  928.                  V1.0 User's Manual
  929.  
  930.  
  931.  
  932.                  IV. ADMINISTRATION
  933.  
  934.  
  935.  
  936.              A. WARRANTY AND DISCLAIMER
  937.  
  938. In view of the fact that The Designer is distributed entirely without charge
  939. and contributions are wholly voluntary,   all warranties are disclaimed.   I
  940. cannot be  responsible in any way  for direct,    indirect,   or consequential
  941. damages.   Any and all risk associated with using The Designer, Demo,  their
  942. data files and/or the documentation is the user's.
  943.  
  944.  
  945.               B. PROGRAM DISTRIBUTION
  946.  
  947. The Designer is distributed without charge.  If you are using it and find it
  948. to be of value, a contribution ($20 suggested) would be appreciated.
  949.  
  950.                Jan B. Young
  951.                767 N. Holden St.
  952.                Port Washington, Wi.  53074
  953.  
  954. Regardless of whether you make a  contribution or not,    individuals,  clubs,
  955. and  other  non-profit organizations  are  granted  permission to  copy  and
  956. distribute programs, data files, and documentation to others, providing that
  957. no charge is made  for the software.   Distribution costs may  be charged to
  958. recipients providing they do not exceed $7 per copy.
  959.  
  960. The programs,  data files,  and documentation  may be modified as desired by
  961. any  individual or  non-profit    organization,    and the  modified  materials
  962. distributed providing the following is    retained without modification:     all
  963. appearances of the copyright notice, all warranty disclaimers,    all material
  964. explaining this  distribution policy,  and  all requests  for contributions.
  965. Users  distributing  modified  program    or  documentation  copies  are    also
  966. required to  add the words "User  Modified" wherever The  Designer's version
  967. number appears and must distribute without charge (other than the $7 maximum
  968. distribution cost).
  969.  
  970.  
  971.              C. QUESTIONS AND PROBLEMS
  972.  
  973. If you have questions about The Designer,  or have experienced problems with
  974. it,  I will try  to help.   Write to me (please don't  phone)  and enclose a
  975. stamped self-addressed envelope for my reply.     Please don't expect return-
  976. mail responses since I travel quite a bit  and may not even read your letter
  977. for a week or two.
  978.  
  979. If The Designer crashes while you are using it,  please let me know so I can
  980. fix the problem.  The more details you provide, the easier it will be for me
  981. to make the fix.
  982.  
  983.  
  984.  
  985.  
  986.  
  987. April 29, 1983                                 Page 14
  988.  
  989.  
  990.  
  991.  
  992.  
  993.                 THE DESIGNER
  994.                  V1.0 User's Manual
  995.  
  996.               D. MAINTENANCE AND ENHANCEMENTS
  997.  
  998. If there is a reasonable level of  interest in The Designer (measured by the
  999. number of  contributions I receive),  I  will create and make  available new
  1000. releases.   Some possibilities for future enhancements include:  1) Variable
  1001. line widths in the "NEW" mode,  2)   Separation of scaling into a compilable
  1002. module so it  will run faster,    3)  use  of color in high  resolution (it is
  1003. possible, but limited), 4)  the ability to rotate images,  and 5)  extension
  1004. into text-mode graphics.   If you have other ideas,  please write and let me
  1005. know what they are.
  1006.  
  1007. If you contribute once,   the suggested contribution is reduced to  $2 for a
  1008. new release.   Just send me a diskette,  a postpaid,  self-addressed mailer,
  1009. and a brief note requesting a copy  of the latest version.   The same policy
  1010. holds if you accidentally  destroy the program and want a  fresh copy of the
  1011. current version.   I will be unable to supply replacement copies of obsolete
  1012. versions.
  1013.  
  1014.  
  1015.  
  1016.  
  1017.  
  1018.  
  1019.  
  1020.  
  1021.  
  1022.  
  1023.  
  1024.  
  1025.  
  1026.  
  1027.  
  1028.  
  1029.  
  1030.  
  1031.  
  1032.  
  1033.  
  1034.  
  1035.  
  1036.  
  1037.  
  1038.  
  1039.  
  1040.  
  1041.  
  1042.  
  1043.  
  1044.  
  1045.  
  1046.  
  1047.  
  1048.  
  1049.  
  1050.  
  1051.  
  1052.  
  1053. April 29, 1983                                 Page 15
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.                 THE DESIGNER
  1060.                  V1.0 User's Manual
  1061.  
  1062.  
  1063.  
  1064.                V. REFERENCE MATERIAL
  1065.  
  1066.  
  1067.                  A. COMMAND SUMMARY
  1068.  
  1069. Function  Command  Explanation
  1070. --------  -------  ----------------------------------------------------
  1071.  1  NEW        Cursor Arrows move the cursor.
  1072.         Fn       Set foreground color to n, where n is 0 or 1 in
  1073.             high resolution; 0, 1, 2, or 3 in medium resolution.
  1074.             Color received depends on palette selelction.
  1075.         D1       Defines the first end of a diagonal line at the
  1076.             current cursor location.
  1077.         D2       Defines the second end of a diagonal line at the
  1078.             current cursor location and causes the line to be
  1079.             drawn in the current foreground color.
  1080.         C1       Defines the center of a circle at the current cursor
  1081.             location.
  1082.         C2       Defines the periphery of a circle at the current
  1083.             cursor location and causes the circle to be drawn
  1084.             in the current foreground color.
  1085.         A1       Defines the center of a circular arc at the current
  1086.             cursor location.
  1087.         A2       Defines the radius of a circular arc and the start-
  1088.             ing position at the current cursor location.  (The
  1089.             arc will be drawn counterclockwise from this
  1090.             position.
  1091.         A3       Defines the ending position of a circular arc as a
  1092.             line from the A1 location to the current cursor
  1093.             position and causes the arc to be drawn in the
  1094.             current foreground color.
  1095.  2  SCL     En       Expand the image by 4*n percent.
  1096.         Cn       Contract the image by 4*n percent.
  1097.  3  SSP        Cursor Arrows reduce the box size.  The up arrow,
  1098.             for instance, raises the bottom of the box.
  1099.          n       Used as a multiplier for the speed of the cursor
  1100.             arrows.
  1101.         G       Signals that the box now represents the size of the
  1102.             sprite and initiates creation of the sprite files.
  1103.  4  SSC        No commands
  1104.  5  RSP        No commands (but return to NEW is automatic and the
  1105.             NEW commands can be used).
  1106.  6  RSC        No commands (but return to NEW is automatic and the
  1107.             NEW commands can be used).
  1108.  
  1109.  
  1110.  
  1111.  
  1112.  
  1113.  
  1114.  
  1115.  
  1116.  
  1117.  
  1118.  
  1119. April 29, 1983                                 Page 16
  1120.  
  1121.  
  1122.  
  1123.  
  1124.  
  1125.                 THE DESIGNER
  1126.                  V1.0 User's Manual
  1127.  
  1128.                A. COMMAND SUMMARY (Continued)
  1129.  
  1130. Function  Command  Explanation
  1131. --------  -------  ----------------------------------------------------
  1132.  7  TXT        Any key (ASCII 33 to 125) can be used to create the
  1133.             corresponding character.
  1134.            Cursor arrows move the most recently created char-
  1135.             acter.
  1136.            Space bar deletes the most recently created char-
  1137.             acter and blanks anything under it.
  1138.  8  ANI        Cursor arrows move the sprite.
  1139.         A       Begins use of ADD mode PUTs.
  1140.         O       Begins use of OR mode PUTs (alpha Oh).
  1141.         X       Begins use of XOR mode PUTs.
  1142.         P       Begins use of PSET mode PUTs (the default).
  1143.  9  INS        Typing any of the three-letter abbreviations will
  1144.             display a series of helps explaining the use of
  1145.             the corresponding function.
  1146.         GEN    Initiates display of helps explaining general
  1147.             topics about The Designer.
  1148.         CRD    Causes printing of the reference card.
  1149.         DRV    Alters the default disk drive.
  1150. 10  Stop       No commands.
  1151.  
  1152.  
  1153.  
  1154.  
  1155.  
  1156.  
  1157.  
  1158.  
  1159.  
  1160.  
  1161.  
  1162.  
  1163.  
  1164.  
  1165.  
  1166.  
  1167.  
  1168.  
  1169.  
  1170.  
  1171.  
  1172.  
  1173.  
  1174.  
  1175.  
  1176.  
  1177.  
  1178.  
  1179.  
  1180.  
  1181.  
  1182.  
  1183.  
  1184.  
  1185. April 29, 1983                                 Page 17
  1186.  
  1187.  
  1188.  
  1189.  
  1190. READY
  1191. APPLICATION B253     LOGON INHIBITED FILE RESTORE CN(00)
  1192.